Motion.SetAxisPosition method

Sets the target position of an axis.

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsError SetAxisPosition(
       int Index,
       double Position
)

Public Function SetAxisPosition(
       Index As Integer,
       Position As Double
) As KsError

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Position

The target position of an axis in user unit.

Return value

A return code of a method.

Remarks

This method can be used only in the Direct Position, PID Velocity, and PID Torque control modes, in which this is the only method to set the target position of an axis.
When modulo axis is enabled, the modulo value is applied to the input position. The axis uses the shortest path to update the target position in order to prevent command jumps. For example, if the modulo value is 360 and the input position is 350, the axis moves 10° in the negative direction.

Examples

N/A